home *** CD-ROM | disk | FTP | other *** search
/ Aminet 4 / Aminet 4 - November 1994.iso / aminet / dev / c / mbedeveloper10.lha / MBE_Developer / Docs / MBE_Developer.doc next >
Text File  |  1994-08-24  |  5KB  |  177 lines
  1.  
  2.  
  3.               MBE - MUI-Brush Expander, Developer Archive
  4.  
  5.                               Version 1.0
  6.  
  7.                            Date: August 1994
  8.  
  9.                         Author: Johannes Beigel
  10.  
  11.                   Copyright © 1994 by Johannes Beigel
  12.  
  13.                                 GIFTWARE
  14.  
  15.                            Developer's Guide
  16.  
  17.  
  18. Introduction
  19. ************
  20.  
  21. IMPORTANT: If you didn't do so, you should get the user archive  of  MBE
  22.   called  'MBE_xx' (where  xx is the version). You should install it and
  23.   read  the  doumenatation.  You  should   have   read   the   developer
  24.   documentation of MUI, too.
  25.  
  26. MBE is a nice thing. But it's also a kind of a hack! So you  should  use
  27. MBE  only  if  you really need it. If you simply want to display a logo,
  28. you shouldn't use MBE but load an ILBM brush with Bodychunk class.
  29.  
  30. The developer version of MBE is Giftware. That  means  that  you  should
  31. send  me  a  gift  if  you  use MBE in your application. I prefer money,
  32. CDs/LPs/MCs with (Hard-)Rock, Blues or Jazz music or FD  software  about
  33. MUI,  MagicWB,  C  programming and MIDI :) You should send at least your
  34. program that uses MBE on disk(s). My address is:
  35.  
  36.                             Johannes Beigel
  37.                             Fliederstr. 43a
  38.                               65396 Walluf
  39.                                 GERMANY
  40.  
  41. I'm sorry, but I don't have a modem.
  42.  
  43. NOTE: A nice gift would be translations the C  include  file  into  some
  44. other  programming  languages.  I only "speak" C (and a little bit C++),
  45. but it would be nice to have Oberon, M2, Assembler... includes  in  this
  46. archive.
  47.  
  48.  
  49. Requirements:
  50. *************
  51.  
  52. You must own MBE ==> You must own at least MUI 2.1 ==> You must  own  at
  53. least OS 2.04.
  54.  
  55. You have to be a registered user of MUI.
  56.  
  57.  
  58. Principle
  59. *********
  60.  
  61. This is the way MBE works:
  62.  
  63. - You create an MBE-image with the developer prefs editor of  MBE.  Then
  64. you save (or 'use') the settings.
  65.  
  66. - You create an object of MBE class in your application, where you  pass
  67. the  ID  of your MBE-image. Since MBE class is a subclass of Image class
  68. (and Area class) you can create a button gadget or something  else  with
  69. your MBE-image.
  70.  
  71. - MBE class loads the settings file at object-creation-time and searches
  72. for  the  given  ID.  If it finds an MBE-image with the ID, it loads the
  73. imagery and displays it.
  74.  
  75. I think the principle is very simple and easy to understand. But the big
  76. advantage for the user is the ability to configure the MBE-images.
  77.  
  78.  
  79. The Developer Prefs-Editor
  80. **************************
  81.  
  82. The developer prefs editor is almost the same program as the user  prefs
  83. editor of MBE. There are only three differences:
  84.  
  85. 1. The developer prefs editor  has  a  'New'  button  to  create  a  new
  86.   MBE-image.
  87.  
  88. 2. The developer prefs editor has a string gadget  for  the  ID  of  the
  89.   MBE-image and not just a text gadget.
  90.  
  91. 3. The of the about requester is different ;-)
  92.  
  93.  
  94. Giving an ID
  95. ************
  96.  
  97. Every MBE-image ID is a longword. You  have  to  take  your  MUI  serial
  98. number  as  upper  word but you mustn't set the highest bit. So you have
  99. 65536 different ID's.
  100.  
  101. Of course the MBE-image ID must be unique.
  102.  
  103.  
  104. Example
  105. -------
  106.  
  107. Let's think of the serial number 12345.
  108.  
  109.     1.    : ( 12345 << 16 )         = 0x30390000 = 809041920
  110.     2.    : ( 12345 << 16 ) | 1     = 0x30390001 = 809041921
  111.     3.    : ( 12345 << 16 ) | 2     = 0x30390002 = 809041922
  112.     .
  113.     .
  114.     .
  115.     65536.: ( 12345 << 16 ) | 65535 = 0x3039FFFF = 809107455
  116.  
  117.  
  118. Creating an MBE-object
  119. **********************
  120.  
  121. First you have to include the include file  'MBE_mcc.h'.  Then  you  can
  122. create an MBE-object using macros.
  123.  
  124. Examples
  125. --------
  126.  
  127. mbe_button = MBEObject,
  128.   ButtonFrame,
  129.   MUIA_Background, MUII_ButtonBack,
  130.   MUIA_InputMode, MUIV_InputMode_RelVerify,
  131.   MUIA_MBE_ID, MY_ID,
  132. End,
  133.  
  134. mbe_button = MBEButton( MY_ID )
  135.  
  136. mbe_image = MBEImage( MY_ID )
  137.  
  138.  
  139. Distributing an MBE Application
  140. *******************************
  141.  
  142. If you distribute an MBE-Application you either have to include the  MBE
  143. archive  into  your  archive (Its size is less than 40K.) or the user of
  144. your application has to get it her/himself.
  145.  
  146. Of course  you  have  to  include  an  MBE  prefs  file  describing  the
  147. MBE-images  that  are needed for your application. If it is useful, you
  148. can include the MUI-brushes for these MBE-images, too.
  149.  
  150. Don't forget to send me this application on disk :)
  151.  
  152.  
  153. Copyright
  154. *********
  155.  
  156. The MBE developer archive is Giftware and copyright © 1994  by  Johannes
  157. Beigel. You are allowed to freely distribute this archive as long as you
  158. distribute the *whole* archive and as long as you don't take  more  than
  159. DM  5  (or  an  corresponding  amount  in  another standard). This price
  160. includes teh costs for a disk but not the postage.
  161.  
  162. You are allowed to distribute the MBE developer  archive  together  with
  163. non-commercial  software.  If  you  want  to distribute it together with
  164. commercial software, you have to write me.
  165.  
  166. The MBE developer archive can be included on PD disks or CD-ROMs.
  167.  
  168.  
  169. Thanks
  170. ******
  171.  
  172. I want to thank Stefan Stuntz, all  MUI-programmers,  Martin  Hutteloher
  173. and all people who draw these nice XEN-style icons, patterns...
  174.  
  175. Thank you, Martin Schulze, for distributing all my stuff.
  176.  
  177.